Documentation Powered by ReDoc

Freight Trust Network TradeInstrument API (1.87.0)

Download OpenAPI specification:Download

This REST API provides the ability to query various data elements in the system.

Please click this link to enable Swagger to call the APIs. Without this step, all attempts to try out the APIs will result in a 401 Not Authorized error.

Event Queries

Fetch unassociated events

query Parameters
size
integer <int32>
Default: 50

Optional, limit to apply to the individual queries for orphaned events and homeless events, max 1000. Since this limit applies to each category of "unassociated events" individually, using a size of 50 could result in at most 100 returned events (50 homeless events, 50 orphaned events).

from
string

Optional, bookmark to get the next chunk of results to a previously executed query. This must be the newFrom value from a previous unassociated events query.

eventTransactionId
string

Optional, only include unassociated events that match this eventTransactionId.

sortBy
string
Enum: "eventOccurrenceTime" "equipmentNumber" "carrierBookingNumber" "billOfLadingNumber"

Optional, the field on which to order the results

sortOrder
string
Default: "ascending"
Enum: "ascending" "descending"

Optional, the sort order to apply to sortBy field.

header Parameters
Accept-Language
string
Default: en

Accept-Language

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "size": 0,
  • "orphanedEvents":
    [
    ],
  • "homelessEvents":
    [
    ],
  • "newFrom": "string"
}

Consignment Queries

Query all consignments

Queries for all consignments visible to the user, filtered using the criteria below.

We return up to a maximum of 1000 consignments in one query. Paging is used to retrieve consignments beyond this number. Provide the "newFrom" value from the response body as the "from" parameter to retrieve the next page of results. If "from" is given, all other parameters are ignored, except for "size".

For the fields listed below, wildcard matching is supported. A '*' can be used in place of one or more characters, and a '?' can replace a single character.

  • exportCountry
  • importCountry
  • entryPort
  • exitPort
  • consignmentId
  • consignmentRef
  • transportEquipmentId
  • transportEquipmentRef
  • harmonizedCode
  • billOfLadingNumber
  • carrierBookingNumber
  • originLocation
  • destinationLocation
  • terminal

Commodity information visibility is restricted to orgs that were onboarded with certain types. If your org does not have one of the correct types, then the following fields will be removed from all consignment response objects, and you will not be allowed to search on these fields:

  • harmonizedCode
  • commodityHarmonizedCode (in the commodities array in bookingData)
  • commodityDescription (in the commodities array in bookingData)
query Parameters
size
integer <int32>
Default: 50

Optional, number of consignments to return, max 1000

from
string

Optional, bookmark to get the next chunk of results to a previously executed query. This must be the newFrom value from a previous consignments query.

createdBy
Array of strings

Optional, only include results that were created by any of the given organizations

createdAfter
integer <int64>

Optional, only include results that were created on or after this date. The date must be in epoch format.

createdBefore
integer <int64>

Optional, only include results that were created on or before this date. The date must be in epoch format.

exportCountry
string

Optional, only include results that match this export country

importCountry
string

Optional, only include results that match this import country

entryPort
string

Optional, only include results that match this entry port

exitPort
string

Optional, only include results that match this exit port

consignmentId
string

Optional, only include results that match this consignment ID

consignmentRef
string

Optional, only include results that match this consignment reference

status
string

Optional, only include results that match this consignment status

transportEquipmentId
string

Optional, only include results with a container that matches this transport equipment ID

transportEquipmentRef
string

Optional, only include results with a container that matches this transport equipment reference

equipmentNumber
string

Optional, only include results with a transport equipment that matches this equipment number

billOfLadingNumber
string

Optional, only include results that match this bill of lading number

harmonizedCode
string

Optional, only include results that match this harmonized system code. Your org must have permission to see commodity information to search on this parameter

carrierBookingNumber
string

Optional, only include results that match this carrier booking number

terminal
string

Optional, only include results that match this terminal name

startPlannedVesselDeparture
integer <int64>

Optional, start date in Planned Vessel Departure date range. Only include results where a consignment leaves the Exit Port (Planned Vessel Departure) on this date or later. The date must be in epoch milliseconds format. The value used will be this epoch day at time 00:00:01 HH:MM:SS

endPlannedVesselDeparture
integer <int64>

Optional, end date in Planned Vessel Departure date range. Only include results where a consignment leaves the Exit Port (Planned Vessel Departure) on this date or earlier. The date must be in epoch milliseconds format. The value used will be this epoch day at time 23:59:59 HH:MM:SS

startPlannedVesselArrival
integer <int64>

Optional, start date in Planned Vessel Arrival date range. Only include results where a consignment arrives at the Entry Port (Planned Vessel Arrival) on this date or later. The date must be in epoch milliseconds format. The value used will be this epoch day at time 00:00:01 HH:MM:SS

endPlannedVesselArrival
integer <int64>

Optional, end date in Planned Vessel Arrival date range. Only include results where a consignment arrives at the Entry Port (Planned Vessel Arrival) on this date or earlier. The date must be in epoch milliseconds format. The value used will be this epoch day at time 23:59:59 HH:MM:SS

originLocation
string

Optional, only include results that match the value of the origin location. Searches for matches in the originLocation in the booking data as well as the exit port

destinationLocation
string

Optional, only include results that match the value of the destination location. Searches for matches in the destinationLocation in the bookingData as well as the entry port

startBookingDepartureDate
integer <int64>

Optional, start departure date in Booking . Only include results where a consignment leaves the origin on this date or later. The date must be in epoch milliseconds format. The value used will be this epoch day at time 00:00:01 HH:MM:SS

endBookingDepartureDate
integer <int64>

Optional, end departure date in Booking. Only include results when a consignment arrives at the destination on this date or earlier. The date must be in epoch milliseconds format. The value used will be this epoch day at time 23:59:59 HH:MM:SS

commodityHarmonizedCode
string

Optional, only include results that match this commodity harmonized system code. Your org must have permission to see harmonized system codes to search on this parameter

commodityDescription
string

Optional, only include results that match this commodity description. Your org must have permission to see commodity information to search on this parameter

vehicleName
string

Optional, only include results that match this vehicleName in the bookingData

header Parameters
Accept-Language
string
Default: en

Accept-Language

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "size": 0,
  • "consignments":
    [
    ],
  • "newFrom": "string"
}

Query for organization names of consignment creators

Queries for the names of all organizations that have created a consignment that the user has access to.

Responses

Response samples

Content type
application/json
{
  • "consignmentCreators":
    [
    ]
}

Query for consignment events by consignment ID

Commodity and originator information visibility is restricted to orgs that were onboarded with certain types. If your org does not have one of these correct types, then you may not have visibility to the following fields in each event: Commodity information:

  • harmonizedCodes
  • bookingData.commodities.commodityDescription
  • bookingData.commodities.commodityHarmonizedCode

Originator information:

  • originatorName
  • originatorId
  • senderOrgId

In addition, The originator information on a Party Add/Update/Remove event will be hidden if you are not the org who submitted the event or one of the parties being added. The originator information and 'destinationOrgName' field on a Document event whose 'action' field is 'issued', 'transferred', or 'surrendered' will be hidden if you are not the org who submitted the event or the org that the document is being transferred to.

path Parameters
consignmentId
required
string

Get the events of this consignment
query Parameters
eventFilter
string
Default: "all"

{all | latest}
header Parameters
Accept-Language
string
Default: en

Accept-Language

Responses

Response samples

Content type
application/json
{
  • "events":
    [
    ]
}

Get the transport summary for a consignment given a consignment ID

Provide the consignment ID for a consignment. Transport Plan Analysis: This endpoint will return all of the transport plans for the consignment, ordered from most recent to oldest. Each transport plan will include a list of planned events, ordered by the event occurrence time. Together these events indicate the series of locations that each transport equipment, that is associated with the given consignnment, will move on its journey.

Planned events provide the planned route of a transport equipment.

Note that the only events returned by this endpoint are the set of events known as “transport” planned events. This does NOT include consignment, transport equipment, generic, or document events. For a complete list of transport events, see the Transport Events category in the Event Publish Swagger documentation. To get all events for a consignment use the …/events/consignmentId/{consignmentId} endpoint.

Commodity and originator information visibility is restricted to orgs that were onboarded with certain types. If your org does not have one of these correct types, then you may not have visibility to the following fields in each event: Commodity information:

  • harmonizedCodes
  • bookingData.commodities.commodityDescription
  • bookingData.commodities.commodityHarmonizedCode

Originator information:

  • originatorName
  • originatorId
  • senderOrgId

In addition, The originator information on a Party Add/Update/Remove event will be hidden if you are not the org who submitted the event or one of the parties being added. The originator information and 'destinationOrgName' field on a Document event whose 'action' field is 'issued', 'transferred', or 'surrendered' will be hidden if you are not the org who submitted the event or the org that the document is being transferred to.

path Parameters
consignmentId
required
string

Consignment ID
header Parameters
Accept-Language
string
Default: en

Accept-Language

Responses

Response samples

Content type
application/json
{
  • "consignment":
    {
    }
}

Query all consignments

Queries for all consignments visible to the user, filtered using the criteria below.

We return up to a maximum of 1000 consignments in one query. Paging is used to retrieve consignments beyond this number. Provide the "newFrom" value from the response body as the "from" parameter to retrieve the next page of results. If "from" is given, all other parameters are ignored, except for "size".

For the fields listed below, wildcard matching is supported. A '*' can be used in place of one or more characters, and a '?' can replace a single character.

  • exportCountry
  • importCountry
  • entryPort
  • exitPort
  • consignmentId
  • references
  • transportEquipmentId
  • transportEquipmentReferences
  • harmonizedCode
  • billOfLadingNumber
  • carrierBookingNumber
  • originLocation
  • destinationLocation
  • terminal

Commodity information visibility is restricted to orgs that were onboarded with certain types. If your org does not have one of the correct types, then the following fields will be removed from all consignment response objects, and you will not be allowed to search on these fields:

  • harmonizedCode
  • commodityHarmonizedCode (in the commodities array in bookingData)
  • commodityDescription (in the commodities array in bookingData)
query Parameters
size
integer <int32>
Default: 50

Optional, number of consignments to return, max 1000

from
string

Optional, bookmark to get the next chunk of results to a previously executed query. This must be the newFrom value from a previous consignments query.

createdBy
Array of strings

Optional, only include results that were created by any of the given organizations

createdAfter
integer <int64>

Optional, only include results that were created on or after this date. The date must be in epoch format.

createdBefore
integer <int64>

Optional, only include results that were created on or before this date. The date must be in epoch format.

exportCountry
string

Optional, only include results that match this export country

importCountry
string

Optional, only include results that match this import country

entryPort
string

Optional, only include results that match this entry port

exitPort
string

Optional, only include results that match this exit port

consignmentId
string

Optional, only include results that match this consignment ID

referenceType
string

Optional, only include results that match this reference type for the consignment.

references
Array of strings

Optional, only include results that match these references number/code for the consignment.

status
string

Optional, only include results that match this consignment status

transportEquipmentId
string

Optional, only include results with a container that matches this transport equipment ID

transportEquipmentReferenceType
string

Optional, only include results that match this transport equipment reference type.

transportEquipmentReferences
Array of strings

Optional, only include results that match these trasport equipment references number/code.

equipmentNumber
string

Optional, only include results with a transport equipment that matches this equipment number

billOfLadingNumber
string

Optional, only include results that match this bill of lading number

harmonizedCode
string

Optional, only include results that match this harmonized system code. Your org must have permission to see commodity information to search on this parameter

carrierBookingNumber
string

Optional, only include results that match this carrier booking number

terminal
string

Optional, only include results that match this terminal name

startPlannedVesselDeparture
integer <int64>

Optional, start date in Planned Vessel Departure date range. Only include results where a consignment leaves the Exit Port (Planned Vessel Departure) on this date or later. The date must be in epoch milliseconds format. The value used will be this epoch day at time 00:00:01 HH:MM:SS

endPlannedVesselDeparture
integer <int64>

Optional, end date in Planned Vessel Departure date range. Only include results where a consignment leaves the Exit Port (Planned Vessel Departure) on this date or earlier. The date must be in epoch milliseconds format. The value used will be this epoch day at time 23:59:59 HH:MM:SS

startPlannedVesselArrival
integer <int64>

Optional, start date in Planned Vessel Arrival date range. Only include results where a consignment arrives at the Entry Port (Planned Vessel Arrival) on this date or later. The date must be in epoch milliseconds format. The value used will be this epoch day at time 00:00:01 HH:MM:SS

endPlannedVesselArrival
integer <int64>

Optional, end date in Planned Vessel Arrival date range. Only include results where a consignment arrives at the Entry Port (Planned Vessel Arrival) on this date or earlier. The date must be in epoch milliseconds format. The value used will be this epoch day at time 23:59:59 HH:MM:SS

originLocation
string

Optional, only include results that match the value of the origin location. Searches for matches in the originLocation in the booking data as well as the exit port

destinationLocation
string

Optional, only include results that match the value of the destination location. Searches for matches in the destinationLocation in the bookingData as well as the entry port

startBookingDepartureDate
integer <int64>

Optional, start departure date in Booking . Only include results where a consignment leaves the origin on this date or later. The date must be in epoch milliseconds format. The value used will be this epoch day at time 00:00:01 HH:MM:SS

endBookingDepartureDate
integer <int64>

Optional, end departure date in Booking. Only include results when a consignment arrives at the destination on this date or earlier. The date must be in epoch milliseconds format. The value used will be this epoch day at time 23:59:59 HH:MM:SS

commodityHarmonizedCode
string

Optional, only include results that match this commodity harmonized system code. Your org must have permission to see commodity information to search on this parameter

commodityDescription
string

Optional, only include results that match this commodity description. Your org must have permission to see commodity information to search on this parameter

vehicleName
string

Optional, only include results that match this vehicleName in the bookingData

onWater
boolean

Optional, only include results where the onWater field equals the given value. OnWater is true if all the equipment for this consignment have been loaded onto the vessel but none have been discharged

transshipment
boolean

Optional, only include results where the transshipment field equals the given value. Transhipment is true if two different vehicle IDs are used in the vessel transport events sent to the consignment or its equipment, indicating its equipment will be transferred between vessels mid journey

startChangeInVesselArrivalFromFirstPlan
integer <int64>

Optional, only include results where the plannedVesselArrival time has changed from its earliest value by the given amount or more, in milliseconds. A negative value for changeInVesselArrivalFromFirstPlan indicates the consignment is arriving earlier than expected, a positive value indicates the consignment is arriving later

endChangeInVesselArrivalFromFirstPlan
integer <int64>

Optional, only include results where the plannedVesselArrival time has changed from its earliest value by the given amount or less, in milliseconds. A negative value for changeInVesselArrivalFromFirstPlan indicates the consignment is arriving earlier than expected, a positive value indicates the consignment is arriving later

startChangeInVesselArrivalFromFirstPlanDays
integer <int64>

Optional, only include results where the plannedVesselArrival time has changed from its earliest value by the given amount or more, in days. A negative value for changeInVesselArrivalFromFirstPlan indicates the consignment is arriving earlier than expected, a positive value indicates the consignment is arriving later

endChangeInVesselArrivalFromFirstPlanDays
integer <int64>

Optional, only include results where the plannedVesselArrival time has changed from its earliest value by the given amount or less, in days. A negative value for changeInVesselArrivalFromFirstPlan indicates the consignment is arriving earlier than expected, a positive value indicates the consignment is arriving later

startLatestPlanIssuanceTime
integer <int64>

Optional, only include results where the latest set of planned events sent to this consignment had a transportPlanIssuanceTime of this time or later. Time in milliseconds since epoch. A user may either use the latestPlanIssuedInLastNDays param or this param, not both

endLatestPlanIssuanceTime
integer <int64>

Optional, only include results where the latest set of planned events sent to this consignment had a transportPlanIssuanceTime of this time or earlier. Time in milliseconds since epoch. A user may either use the latestPlanIssuedInLastNDays param or this param, not both

latestPlanIssuedInLastNDays
integer <int64>

Optional, only include results where the transport plan for this consignment was changed between now and n days ago. The consignment must have received more than one complete transport plan for the plan to have "changed". A user may not supply both this field and any of startNumberPlansReceived, endNumberPlansReceived, startLatestPlanIssuanceTime, endLatestPlanIssuanceTime, or planChangedLastNDays

planChangedLastNDays
integer <int64>

Optional, only include results where the transport plan for this consignment was changed between now and n days ago. The consignment must have received more than one complete transport plan for the plan to have "changed". A user may not supply both this field and any of startNumberPlansReceived, endNumberPlansReceived, startLatestPlanIssuanceTime, endLatestPlanIssuanceTime, or latestPlanIssuedInLastNDays

startNumberPlansReceived
integer <int64>

Optional, only include consignments which have received at least this many complete transport plans (inclusive)

endNumberPlansReceived
integer <int64>

Optional, only include consignments which have received at most this many complete transport plans (inclusive)

header Parameters
Accept-Language
string
Default: en

Accept-Language

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "size": 0,
  • "consignments":
    [
    ],
  • "newFrom": "string"
}

Shipment Queries

Query all shipments

Queries for all shipments visible to the user, filtered using the criteria below.

We return up to a maximum of 1000 shipments in one query. Paging is used to retrieve shipments beyond this number. Provide the "newFrom" value from the response body as the "from" parameter to retrieve the next page of results. If "from" is given, all other parameters are ignored, except for "size".

Note: A leading wildcard will not be added to shipment queries.

query Parameters
size
integer <int32>
Default: 50

Optional, number of shipments to return, max 1000.

from
string

Optional, bookmark to get the next chunk of results to a previously executed query. This must be the newFrom value from a previous shipment query.

shipmentId
string

Optional, only include results that match this shipment ID.

createdBy
Array of strings

Optional, only include results that were created by the given party.

createdAfter
integer <int64>

Optional, only include results that were created on or after this date. The date must be in epoch format.

createdBefore
integer <int64>

Optional, only include results that were created on or before this date. The date must be in epoch format.

myRole
string

Optional, only include results where the caller has one of the given roles.

referenceType
string

Optional, only include results that match this reference type for the shipment.

references
Array of strings

Optional, only include results that match these references number/code for the shipment.

seller
string

Optional, only include results where the party reference matches the role.

buyer
string

Optional, only include results where the party reference matches the role.

exporter
string

Optional, only include results where the party reference matches the role.

importer
string

Optional, only include results where the party reference matches the role.

origin3plAgent
string

Optional, only include results where the party reference matches the role.

destination3plAgent
string

Optional, only include results where the party reference matches the role.

exportCustomsBroker
string

Optional, only include results where the party reference matches the role.

importCustomsBroker
string

Optional, only include results where the party reference matches the role.

exportAuthority
string

Optional, only include results where the party reference matches the role.

importAuthority
string

Optional, only include results where the party reference matches the role.

buyersBank
string

Optional, only include results where the party reference matches the role.

sellersBank
string

Optional, only include results where the party reference matches the role.

insuranceProvider
string

Optional, only include results where the party reference matches the role.

header Parameters
Accept-Language
string
Default: en

Accept-Language

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "size": 0,
  • "shipments":
    [
    ],
  • "newFrom": "string"
}

Query for organization names of shipment creators

Queries for the names of all organizations that have created a shipment that the user has access to.

Responses

Response samples

Content type
application/json
{
  • "shipmentCreators":
    [
    ]
}

Fetch a specific shipment's events

path Parameters
shipmentId
required
string

Fetch the events for a specific shipment.
query Parameters
eventFilter
string
Default: "all"

{all | latest}
header Parameters
Accept-Language
string
Default: en

Accept-Language

Responses

Response samples

Content type
application/json
{
  • "events":
    [
    ]
}

Trade Instrument Id Queries

Query for a Freight Trust Network object id by external references.

Queries for unique IDs of Freight Trust Network objects matching the given search criteria.

Search for consignments by providing the 'consignment' search criteria. Matching consignment IDs are returned.

Search for transport equipments by providing the 'transportEquipment' search criteria. Matching transport equipment IDs are returned.

Search for shipments by providing the 'shipment' search criteria. Matching shipment IDs are returned.

Request Body schema: application/json

See Model to the right for the full description of the identifiers. Note that only one identifier can be specified (consignment, transportEquipment or shipment) and within that identifier, at least one field must be specified but not all are required.

object (ConsignmentIdentifer)
object (TransportEquipmentIdentifier)
object (ShipmentIdentifer)

Responses

Request samples

Content type
application/json
{
  • "consignment":
    {
    },
  • "transportEquipment":
    {
    },
  • "shipment":
    {
    }
}

Response samples

Content type
application/json
{
  • "tradeObjectIds":
    [
    ]
}

Transport Equipment Queries

Get the current progress for one or more pieces of transport equipment

Provide the consignmentId of a Consignment. Returns the current progress of all transport equipment associated with that consignment.

Transport events are divided into three categories: planned, estimated and actual. Planned events provide the planned route of a transport equipment. Estimated events provide the estimated time things will occur to the transport equipment. Actual events indicate things that occurred to the transport equipment.

Current Progress Analysis: The current progress will include a list of current progress events, ordered by the sequence in which they occur. Together these events indicate the series of locations that each transport equipment will move, or has moved, on its journey and everything that happened to it along the way. Each current progress event is made up of a list of actual events, a list of estimated events and the associated planned event.

Note that the only events returned by this endpoint are the set of events known as “transport” events. This does NOT include consignment, transport equipment, generic, or document events. For a complete list of transport events, see the Transport Events category in the Event Publish Swagger documentation. To get all events for a consignment or transport equipment, use the …/events/... endpoint.

Commodity and originator information visibility is restricted to orgs that were onboarded with certain types. If your org does not have one of these correct types, then you may not have visibility to the following fields in each event: Commodity information:

  • harmonizedCodes
  • bookingData.commodities.commodityDescription
  • bookingData.commodities.commodityHarmonizedCode

Originator information:

  • originatorName
  • originatorId
  • senderOrgId

In addition, The originator information on a Party Add/Update/Remove event will be hidden if you are not the org who submitted the event or one of the parties being added. The originator information and 'destinationOrgName' field on a Document event whose 'action' field is 'issued', 'transferred', or 'surrendered' will be hidden if you are not the org who submitted the event or the org that the document is being transferred to.

path Parameters
consignmentId
required
string

Consignment ID
header Parameters
Accept-Language
string
Default: en

Accept-Language

Responses

Response samples

Content type
application/json
{
  • "consignment":
    {
    },
  • "transportEquipmentList":
    [
    ]
}

Get the current progress for one or more pieces of transport equipment that were split from the consignment with the given consignment ID

Provide the consignmentId for a consignment. Returns the current progress for all of the transport equipment split from the consignment that are not yet associated with another consignment. Current Progress Analysis: The current progress will include a list of current progress events, ordered by the sequence in which they occur. Together these events indicate the series of locations that each transport equipment will move, or has moved, on its journey and everything that happened to it along the way. Each current progress event is made up of a list of actual events, a list of estimated events and the associated planned event.

Note that the only events returned by this endpoint are the set of events known as “transport” events. This does NOT include consignment, transport equipment, generic, or document events. For a complete list of transport events, see the Transport Events category in the Event Publish Swagger documentation. To get all events for a consignment or transport equipment, use the …/events/... endpoint.

Commodity and originator information visibility is restricted to orgs that were onboarded with certain types. If your org does not have one of these correct types, then you may not have visibility to the following fields in each event: Commodity information:

  • harmonizedCodes
  • bookingData.commodities.commodityDescription
  • bookingData.commodities.commodityHarmonizedCode

Originator information:

  • originatorName
  • originatorId
  • senderOrgId

In addition, The originator information on a Party Add/Update/Remove event will be hidden if you are not the org who submitted the event or one of the parties being added. The originator information and 'destinationOrgName' field on a Document event whose 'action' field is 'issued', 'transferred', or 'surrendered' will be hidden if you are not the org who submitted the event or the org that the document is being transferred to.

path Parameters
consignmentId
required
string

Consignment ID
header Parameters
Accept-Language
string
Default: en

Accept-Language

Responses

Response samples

Content type
application/json
{
  • "consignment":
    {
    },
  • "transportEquipmentList":
    [
    ]
}

Get the current progress for a transport equipment

Provide the transport equipment ID of a transport equipment. Returns the current progress of the transport equipment with that ID. Transport events are divided into three categories: planned, estimated and actual. Planned events provide the planned route of a transport equipment. Estimated events provide the estimated time things will occur to the transport equipment. Actual events indicate things that occurred to the transport equipment.

Current Progress Analysis: The current progress will include a list of current progress events, ordered by the sequence in which they occur. Together these events indicate the series of locations that each transport equipment will move, or has moved, on its journey and everything that happened to it along the way. Each current progress event is made up of a list of actual events, a list of estimated events and the associated planned event.

Note that the only events returned by this endpoint are the set of events known as “transport” events. This does NOT include consignment, transport equipment, generic, or document events. For a complete list of transport events, see the Transport Events category in the Event Publish Swagger documentation. To get all events for a consignment or transport equipment, use the …/events/... endpoint.

Commodity and originator information visibility is restricted to orgs that were onboarded with certain types. If your org does not have one of these correct types, then you may not have visibility to the following fields in each event: Commodity information:

  • harmonizedCodes
  • bookingData.commodities.commodityDescription
  • bookingData.commodities.commodityHarmonizedCode

Originator information:

  • originatorName
  • originatorId
  • senderOrgId

In addition, The originator information on a Party Add/Update/Remove event will be hidden if you are not the org who submitted the event or one of the parties being added. The originator information and 'destinationOrgName' field on a Document event whose 'action' field is 'issued', 'transferred', or 'surrendered' will be hidden if you are not the org who submitted the event or the org that the document is being transferred to.

path Parameters
transportEquipmentId
required
string

Transport Equipment ID
header Parameters
Accept-Language
string
Default: en

Accept-Language

Responses

Response samples

Content type
application/json
{
  • "consignment":
    {
    },
  • "transportEquipmentList":
    [
    ]
}

Query TE events by consignment ID

Query for events belonging to all Transport Equipments associated with the Consignment with the given ID. The event filter parameter can be used to control how much processing is done to the resulting list.

  • latest - Only the most recent versions of an event will be returned. The transportPlanIssuanceTime8601 will be used to determine the most recent Planned events. All Actual events will be returned, no filtering is done. For Estimated events, the location, the eventSubmissionTime, the originatorId, and the fullStatus fields will be used. For non transport events, the eventSubmissionTime will be used.
  • all - No filtering is done. All events are returned.

If the eventFilter is not specified, the default is "all". You may optionally specify a transportEquipmentId to return only results for the transport equipment with that ID.

The list of events are sorted on occurrence time if present, otherwise the submission time.

Commodity and originator information visibility is restricted to orgs that were onboarded with certain types. If your org does not have one of these correct types, then you may not have visibility to the following fields in each event: Commodity information:

  • harmonizedCodes
  • bookingData.commodities.commodityDescription
  • bookingData.commodities.commodityHarmonizedCode

Originator information:

  • originatorName
  • originatorId
  • senderOrgId

In addition, The originator information on a Party Add/Update/Remove event will be hidden if you are not the org who submitted the event or one of the parties being added. The originator information and 'destinationOrgName' field on a Document event whose 'action' field is 'issued', 'transferred', or 'surrendered' will be hidden if you are not the org who submitted the event or the org that the document is being transferred to.

path Parameters
consignmentId
required
string

Consignment ID
query Parameters
eventFilter
string

{all | latest}
transportEquipmentIdFilter
string

Transport Equipment ID
header Parameters
Accept-Language
string
Default: en

Accept-Language

Responses

Response samples

Content type
application/json
{
  • "events":
    [
    ]
}

Query TE events by TE ID

Query for events for the Transport Equipment with the given ID. The event filter parameter can be used to control how much processing is done to the resulting list.

  • latest - Only the most recent versions of an event will be returned. The transportPlanIssuanceTime8601 will be used to determine the most recent Planned events. All Actual events will be returned, no filtering is done. For Estimated events, the location, the eventSubmissionTime, the originatorId, and the fullStatus fields will be used. For non transport events, the eventSubmissionTime will be used.
  • all - No filtering is done. All events are returned.

If the eventFilter is not specified, the default is "all". You may optionally specify a transportEquipmentId to return only results for the transport equipment with that ID.

The list of events are sorted on occurrence time if present, otherwise the submission time.

Commodity and originator information visibility is restricted to orgs that were onboarded with certain types. If your org does not have one of these correct types, then you may not have visibility to the following fields in each event: Commodity information:

  • harmonizedCodes
  • bookingData.commodities.commodityDescription
  • bookingData.commodities.commodityHarmonizedCode

Originator information:

  • originatorName
  • originatorId
  • senderOrgId

In addition, The originator information on a Party Add/Update/Remove event will be hidden if you are not the org who submitted the event or one of the parties being added. The originator information and 'destinationOrgName' field on a Document event whose 'action' field is 'issued', 'transferred', or 'surrendered' will be hidden if you are not the org who submitted the event or the org that the document is being transferred to.

path Parameters
transportEquipmentId
required
string

Transport Equipment ID
query Parameters
eventFilter
string

{all | latest}
header Parameters
Accept-Language
string
Default: en

Accept-Language

Responses

Response samples

Content type
application/json
{
  • "events":
    [
    ]
}

Get the transport summary for one or more pieces of transport equipment

Provide the consignmentId of a Consignment. Returns the transport summary of all transport equipment associated with that consignment. Transport Plan Analysis: This endpoint will construct an up-to-date transport summary for each transport equipment returned by the query. This transport summary will include a list of transport plan events, ordered by the sequence in which they occur. Together these events indicate the series of locations that each transport equipment will move, or has moved, on its journey and everything that happened to it along the way.

Events are divided into three categories: planned, estimated and actual. Planned events provide the planned route of a transport equipment. Estimated events provide the estimated time things will occur to the transport equipment. Actual events indicate things that occurred to the transport equipment.

The event filter parameter can be used to control the processing done in the transport plan analysis.

  • latest - The transportPlanIssuanceTime8601 will be used to determine the most recent transport plan. All Actual events will be returned, no filtering is done. For Estimated events, the location, the eventSubmissionTime, the originatorId, and the fullStatus fields will be used to determine the most recent version of the event. Estimated events will be replaced by the corresponding Actual events. The resulting list will contain the Planned event (if there is one) followed by the Actual or Estimated (if not Actual).

  • all - All the transport plans sent to this trade object will be returned, from most recent to oldest. Each transport plan will have a version, the transport plan issuance date, and the name of the organization that sent the plan, along with the list of Planned events.

Note that the only events returned by this endpoint are the set of events known as “transport”events. This does NOT include consignment, transport equipment, generic, or document events. For a complete list of transport events, see the Transport Events category in the Event Publish Swagger documentation. To get all events for a consignment or transport equipment, use the …/events/... endpoint.

Commodity and originator information visibility is restricted to orgs that were onboarded with certain types. If your org does not have one of these correct types, then you may not have visibility to the following fields in each event: Commodity information:

  • harmonizedCodes
  • bookingData.commodities.commodityDescription
  • bookingData.commodities.commodityHarmonizedCode

Originator information:

  • originatorName
  • originatorId
  • senderOrgId

In addition, The originator information on a Party Add/Update/Remove event will be hidden if you are not the org who submitted the event or one of the parties being added. The originator information and 'destinationOrgName' field on a Document event whose 'action' field is 'issued', 'transferred', or 'surrendered' will be hidden if you are not the org who submitted the event or the org that the document is being transferred to.

path Parameters
consignmentId
required
string

Consignment ID
query Parameters
eventFilter
string

{all | latest}
header Parameters
Accept-Language
string
Default: en

Accept-Language

Responses

Response samples

Content type
application/json
{
  • "consignment":
    {
    },
  • "transportEquipmentList":
    [
    ]
}

Get the transport summary for one or more pieces of transport equipment that were split from the consignment with the given consignment ID

Provide the consignmentId for a consignment. Returns the transport summary for all of the transport equipment split from the consignment that are not yet associated with another consignment. Transport Plan Analysis: This endpoint will construct an up-to-date transport summary for each transport equipment returned by the query. This transport summary will include a list of transport plan events, ordered by the sequence in which they occur. Together these events indicate the series of locations that each transport equipment will move, or has moved, on its journey and everything that happened to it along the way.

Events are divided into three categories: planned, estimated and actual. Planned events provide the planned route of a transport equipment. Estimated events provide the estimated time things will occur to the transport equipment. Actual events indicate things that occurred to the transport equipment.

The event filter parameter can be used to control the processing done in the transport plan analysis.

  • latest - The transportPlanIssuanceTime8601 will be used to determine the most recent transport plan. All Actual events will be returned, no filtering is done. For Estimated events, the location, the eventSubmissionTime, the originatorId, and the fullStatus fields will be used to determine the most recent version of the event. Estimated events will be replaced by the corresponding Actual events. The resulting list will contain the Planned event (if there is one) followed by the Actual or Estimated (if not Actual).

  • all - All the transport plans sent to this transport equipment will be returned, from most recent to oldest. Each transport plan will have a version, the transport plan issuance date, and the name of the organization that sent the plan, along with the list of Planned events.

Note that the only events returned by this endpoint are the set of events known as “transport”events. This does NOT include consignment, transport equipment, generic, or document events.. For a complete list of transport events, see the Transport Events category in the Event Publish Swagger documentation. To get all events for a consignment or transport equipment, use the …/events/... endpoint.

Commodity and originator information visibility is restricted to orgs that were onboarded with certain types. If your org does not have one of these correct types, then you may not have visibility to the following fields in each event: Commodity information:

  • harmonizedCodes
  • bookingData.commodities.commodityDescription
  • bookingData.commodities.commodityHarmonizedCode

Originator information:

  • originatorName
  • originatorId
  • senderOrgId

In addition, The originator information on a Party Add/Update/Remove event will be hidden if you are not the org who submitted the event or one of the parties being added. The originator information and 'destinationOrgName' field on a Document event whose 'action' field is 'issued', 'transferred', or 'surrendered' will be hidden if you are not the org who submitted the event or the org that the document is being transferred to.

path Parameters
consignmentId
required
string

Consignment ID
query Parameters
eventFilter
string

{all | latest}
header Parameters
Accept-Language
string
Default: en

Accept-Language

Responses

Response samples

Content type
application/json
{
  • "consignment":
    {
    },
  • "transportEquipmentList":
    [
    ]
}

Get the transport summary a transport equipment

Provide the transport equipment ID of a transport equipment. Returns the transport summary of the transport equipment with that ID. Transport Plan Analysis: This endpoint will construct an up-to-date transport summary for each transport equipment returned by the query. This transport summary will include a list of transport plan events, ordered by the sequence in which they occur. Together these events indicate the series of locations that each transport equipment will move, or has moved, on its journey and everything that happened to it along the way.

Events are divided into three categories: planned, estimated and actual. Planned events provide the planned route of a transport equipment. Estimated events provide the estimated time things will occur to the transport equipment. Actual events indicate things that occurred to the transport equipment.

The event filter parameter can be used to control the processing done in the transport plan analysis.

  • latest - The transportPlanIssuanceTime8601 will be used to determine the most recent transport plan. All Actual events will be returned, no filtering is done. For Estimated events, the location, the eventSubmissionTime, the originatorId, and the fullStatus fields will be used to determine the most recent version of the event. Estimated events will be replaced by the corresponding Actual events. The resulting list will contain the Planned event (if there is one) followed by the Actual or Estimated (if not Actual).

  • all - All the transport plans sent to this transport equipment will be returned, from most recent to oldest. Each transport plan will have a version, the transport plan issuance date, and the name of the organization that sent the plan, along with the list of Planned events.

Note that the only events returned by this endpoint are the set of events known as “transport”events. This does NOT include consignment, transport equipment, generic, or document events. For a complete list of transport events, see the Transport Events category in the Event Publish Swagger documentation. To get all events for a consignment or transport equipment, use the …/events/... endpoint.

Commodity and originator information visibility is restricted to orgs that were onboarded with certain types. If your org does not have one of these correct types, then you may not have visibility to the following fields in each event: Commodity information:

  • harmonizedCodes
  • bookingData.commodities.commodityDescription
  • bookingData.commodities.commodityHarmonizedCode

Originator information:

  • originatorName
  • originatorId
  • senderOrgId

In addition, The originator information on a Party Add/Update/Remove event will be hidden if you are not the org who submitted the event or one of the parties being added. The originator information and 'destinationOrgName' field on a Document event whose 'action' field is 'issued', 'transferred', or 'surrendered' will be hidden if you are not the org who submitted the event or the org that the document is being transferred to.

path Parameters
transportEquipmentId
required
string

Transport Equipment ID
query Parameters
eventFilter
string

{all | latest}
header Parameters
Accept-Language
string
Default: en

Accept-Language

Responses

Response samples

Content type
application/json
{
  • "consignment":
    {
    },
  • "transportEquipmentList":
    [
    ]
}